/*
 *
 *  Copyright (C) 2010 Tal Eisenberg
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package tal.drivechain.variable.types;

import tal.drivechain.chain.ChainNode;
import tal.drivechain.expression.dcExpression;
import tal.drivechain.variable.Variable;
import tal.drivechain.wildcard.Wildcard;

/**
 *
 * @author Main
 */
public interface IndexableType {

    /**
     * Returns an updated version of workon based on the value of Variable value and index.
     * 
     * @param workon
     * @param value
     * @param index
     * @param references
     * @return the value that should be set.
     * @throws java.lang.IllegalArgumentException
     */
    public Object setByIndex(Object workon, Variable value, dcExpression index, ChainNode context) throws IllegalArgumentException;
    public Variable getByIndex(Wildcard index, Variable from, ChainNode context) throws IllegalArgumentException;
    
    public boolean isNestingAllowed();
    public Object getNextDimension(Object workon, Object modifier, ChainNode context);
}
